/*
 * Copyright 2012-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.web.servlet.context;

import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.function.Supplier;

import org.springframework.beans.factory.config.BeanDefinitionCustomizer;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.support.BeanNameGenerator;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.context.annotation.AnnotatedBeanDefinitionReader;
import org.springframework.context.annotation.AnnotationConfigRegistry;
import org.springframework.context.annotation.AnnotationConfigUtils;
import org.springframework.context.annotation.AnnotationScopeMetadataResolver;
import org.springframework.context.annotation.ClassPathBeanDefinitionScanner;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ScopeMetadataResolver;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.stereotype.Component;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;
import org.springframework.util.ObjectUtils;
import org.springframework.web.context.support.GenericWebApplicationContext;

/**
 * 一个支持注解类作为输入的 {@link GenericWebApplicationContext} 实现 ——
 * 尤其是带有 {@link Configuration @Configuration} 注解的类，
 * 也支持普通的 {@link Component @Component} 类以及使用
 * {@code javax.inject} 注解的符合 JSR-330 标准的类。
 * 允许逐个注册类（通过指定类名作为配置位置），也支持通过类路径扫描
 * （通过指定基础包名作为配置位置）。
 * <p>
 * 注意：如果存在多个 {@code @Configuration} 类，后加载的 {@code @Bean} 定义
 * 会覆盖之前加载文件中定义的同名 Bean。这可以用来通过额外的配置类有意地
 * 覆盖某些 Bean 定义。
 *
 * @author Stephane Nicoll
 * @since 2.2.0
 * @see #register(Class...)
 * @see #scan(String...)
 */
public class AnnotationConfigServletWebApplicationContext extends GenericWebApplicationContext
		implements AnnotationConfigRegistry {

	private final AnnotatedBeanDefinitionReader reader;

	private final ClassPathBeanDefinitionScanner scanner;

	private final Set<Class<?>> annotatedClasses = new LinkedHashSet<>();

	private String[] basePackages;

	/**
	 * 创建一个新的 {@link AnnotationConfigServletWebApplicationContext} 实例，
	 * 需要通过 {@link #register} 方法手动注册 Bean，然后调用 {@linkplain #refresh}
	 * 刷新上下文。
	 */
	public AnnotationConfigServletWebApplicationContext() {
		this.reader = new AnnotatedBeanDefinitionReader(this);
		this.scanner = new ClassPathBeanDefinitionScanner(this);
	}

	/**
	 * 使用给定的 {@code DefaultListableBeanFactory} 创建一个新的
	 * {@link AnnotationConfigServletWebApplicationContext} 实例。
	 * 该上下文需要通过 {@link #register} 方法手动注册 Bean，然后调用
	 * {@linkplain #refresh} 刷新上下文。
	 * @param beanFactory 用于该上下文的 DefaultListableBeanFactory 实例
	 */
	public AnnotationConfigServletWebApplicationContext(DefaultListableBeanFactory beanFactory) {
		super(beanFactory);
		this.reader = new AnnotatedBeanDefinitionReader(this);
		this.scanner = new ClassPathBeanDefinitionScanner(this);
	}

	/**
	 * 创建一个新的 {@link AnnotationConfigServletWebApplicationContext} 实例，
	 * 从给定的注解类中派生 Bean 定义，并自动刷新上下文。
	 * @param annotatedClasses 一个或多个注解类，例如 {@code @Configuration} 类
	 */
	public AnnotationConfigServletWebApplicationContext(Class<?>... annotatedClasses) {
		this();
		register(annotatedClasses);
		refresh();
	}

	/**
	 * 创建一个新的 {@link AnnotationConfigServletWebApplicationContext} 实例，
	 * 扫描指定的包中的 Bean 定义并自动刷新上下文。
	 * @param basePackages 要扫描的基础包路径
	 */
	public AnnotationConfigServletWebApplicationContext(String... basePackages) {
		this();
		scan(basePackages);
		refresh();
	}

	/**
	 * {@inheritDoc}
	 * <p>
	 * 将指定的环境委托给底层的 {@link AnnotatedBeanDefinitionReader} 和
	 * {@link ClassPathBeanDefinitionScanner}。
	 */
	@Override
	public void setEnvironment(ConfigurableEnvironment environment) {
		super.setEnvironment(environment);
		this.reader.setEnvironment(environment);
		this.scanner.setEnvironment(environment);
	}

	/**
	 * 提供自定义的 {@link BeanNameGenerator}，用于 {@link AnnotatedBeanDefinitionReader}
	 * 和/或 {@link ClassPathBeanDefinitionScanner}。
	 * <p>
	 * 默认实现为 {@link org.springframework.context.annotation.AnnotationBeanNameGenerator}。
	 * <p>
	 * 本方法必须在调用 {@link #register(Class...)} 和/或 {@link #scan(String...)} 之前执行。
	 * @param beanNameGenerator Bean 名称生成器
	 * @see AnnotatedBeanDefinitionReader#setBeanNameGenerator
	 * @see ClassPathBeanDefinitionScanner#setBeanNameGenerator
	 */
	public void setBeanNameGenerator(BeanNameGenerator beanNameGenerator) {
		this.reader.setBeanNameGenerator(beanNameGenerator);
		this.scanner.setBeanNameGenerator(beanNameGenerator);
		getBeanFactory().registerSingleton(AnnotationConfigUtils.CONFIGURATION_BEAN_NAME_GENERATOR, beanNameGenerator);
	}

	/**
	 * 设置用于解析已检测到的 Bean 类的 {@link ScopeMetadataResolver}。
	 * <p>
	 * 默认实现为 {@link AnnotationScopeMetadataResolver}。
	 * <p>
	 * 必须在调用 {@link #register(Class...)} 和/或 {@link #scan(String...)} 之前调用本方法。
	 * @param scopeMetadataResolver 要使用的作用域元数据解析器
	 */
	public void setScopeMetadataResolver(ScopeMetadataResolver scopeMetadataResolver) {
		this.reader.setScopeMetadataResolver(scopeMetadataResolver);
		this.scanner.setScopeMetadataResolver(scopeMetadataResolver);
	}

	/**
	 * 注册一个或多个带注解的类以供处理。注意，必须调用 {@link #refresh()} 才能使上下文完全处理新注册的类。
	 * <p>
	 * 对 {@code #register} 的调用是幂等的；多次添加相同的注解类不会产生额外影响。
	 * @param annotatedClasses 一个或多个带注解的类，例如 {@code @Configuration} 类
	 * @see #scan(String...)
	 * @see #refresh()
	 */
	@Override
	public final void register(Class<?>... annotatedClasses) {
		Assert.notEmpty(annotatedClasses, "At least one annotated class must be specified");
		this.annotatedClasses.addAll(Arrays.asList(annotatedClasses));
	}

	/**
	 * 在指定的基础包内执行扫描操作。注意，必须调用 {@link #refresh()} 才能使上下文完全处理新扫描到的类。
	 * @param basePackages 要扫描的基础包路径
	 * @see #register(Class...)
	 * @see #refresh()
	 */
	@Override
	public final void scan(String... basePackages) {
		Assert.notEmpty(basePackages, "At least one base package must be specified");
		this.basePackages = basePackages;
	}

	@Override
	protected void prepareRefresh() {
		this.scanner.clearCache();
		super.prepareRefresh();
	}

	@Override
	protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) {
		super.postProcessBeanFactory(beanFactory);
		if (!ObjectUtils.isEmpty(this.basePackages)) {
			this.scanner.scan(this.basePackages);
		}
		if (!this.annotatedClasses.isEmpty()) {
			this.reader.register(ClassUtils.toClassArray(this.annotatedClasses));
		}
	}

	@Override
	public <T> void registerBean(String beanName, Class<T> beanClass, Supplier<T> supplier,
			BeanDefinitionCustomizer... customizers) {
		this.reader.registerBean(beanClass, beanName, supplier, customizers);
	}

}
